[codex] Clean up slack-post install docs and env vars#3
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the slack-post tool’s installation/configuration documentation and renames its environment variable namespace from SLACK_E2E_* to SLACK_POST_* across code, tests, and docs, aligning the CLI contract with its standalone usage and Homebrew distribution.
Changes:
- Add a Homebrew-first install path and improve top-level README links to
slack-postdocs and.env.example. - Rename all
slack-postenvironment variables fromSLACK_E2E_*toSLACK_POST_*in CLI code and user-facing error/help text. - Update tests and command documentation/templates to match the new env var names.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds Homebrew install guidance and clearer links to per-tool docs/env templates. |
| internal/cli/slackpost/command.go | Switches env var lookups/help/error strings from SLACK_E2E_* to SLACK_POST_*. |
| internal/cli/slackpost/command_test.go | Updates test env setup and assertions to use SLACK_POST_*. |
| cmd/slack-post/README.md | Refreshes usage/docs tables to reference SLACK_POST_* variables. |
| cmd/slack-post/.env.example | Renames the example configuration keys to SLACK_POST_*. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
brew install berrydev-ai/tap/slack-post.slack-postcommand docs and env template.slack-postconfiguration from the oldSLACK_E2E_*names to theSLACK_POST_*namespace in code, tests, docs, and.env.example.Why
slack-postnow has a Homebrew distribution path, so the main README should point users to the tap while still distinguishing released binaries from current source docs.SLACK_E2E_*namespace was tied to the original test harness wording;SLACK_POST_*better matches the standalone CLI contract.Impact
slack-postfrom source docs should useSLACK_POST_BOT_TOKEN,SLACK_POST_TARGET_CHANNEL,SLACK_POST_TARGET_BOT_MEMBER_ID, and optionalSLACK_POST_<TARGET>_BOT_MEMBER_IDvalues.Test Plan
git diff --checkenv GOCACHE=/private/tmp/agent-cli-tools-go-cache go test ./...env GOCACHE=/private/tmp/agent-cli-tools-go-cache make buildrg --hidden -n "SLACK_E2E" .returned no matches